Release 10.1A: OpenEdge Development:
Java Open Clients

Preface

This Preface contains the following sections:

Purpose
Audience
Organization
Typographical conventions
Example procedures

Purpose

The Open Client Toolkit (a component of OpenEdge® Studio) exposes AppServer functionality to Open Clients (non-Progress clients). As discussed in OpenEdge Development: Open Client Introduction and Programming , the ProxyGen tool allows you to generate proxy objects for Java (and other) Open Clients. These proxy objects encapsulate remote 4GL procedures and functions supported on an AppServer. Your Java Open Client application can then access these AppServer procedures and functions through methods of the generated proxy objects.

This book contains Java-specific information about creating and using Open Clients. It describes how to develop Java Open Clients and how to provide access to Progress® 4GL business logic from Java clients.

Audience

This book is intended for Java programmers who want to develop Open Clients and OpenEdge developers who want to provide access to their Progress® 4GL business logic from Java clients.

Before reading this book, you should be familiar with OpenEdge Development: Open Client Introduction and Programming and OpenEdge Getting Started: Application and Integration Services .

Organization

Chapter 1 "Configuring and Deploying Java Open Client Applications"

Describes configuration prerequisites specific to Java Open Client development and deployment.

Chapter 2 "Proxy Objects and Methods"

Describes the objects and methods generated by ProxyGen for a Java Open Client.

Chapter 3 "Connecting to an AppServer"

Describes how to connect to an ™, by instantiating an AppObject and, optionally, a Connection object.

Chapter 4 "Passing Parameters"

Describes mappings for basic data types and static and dynamic temp-tables when data is passed between a Java application and OpenEdge.

Chapter 5 "Accessing Progress ProDataSets"

Describes how to pass and manage ProDataSet and temp-table parameters as OpenEdge ProDataGraph objects

Chapter 6 "Extending Proxy Objects"

Describes how to extend the AppObjects, SubAppObjects, and ProcObjects created by ProxyGen for Java applications.

Chapter 7 "Accessing Proxy Properties"

Describes the different ways you can access the proxy properties that govern behavior across an entire application.

Chapter 8 "Handling Errors"

Describes error handling in Java Open Client applications.

Chapter 9 "Using SmartDataObjects from Java Clients"

Describes how to access and use an interface that enables any Java™ application to access a remote Progress SmartDataObject. The supported interface is based on the Java Database Connectivity (JDBC) 2 ResultSet. The interface includes many of the standard ResultSet methods and adds a number of extensions.

Chapter 10 "Building Java applets as Open Clients"

Describes the process for building a Java applet that runs as an Open Client; that is, the applet can make proxy method calls to remote AppServer procedures from the Web browser environment. You must include additional code to allow the Web browser to accept the Open Client applet for execution.

Chapter 11 "Using the Open Client Java OpenAPI to Directly Access the AppServer"

Describes an API for accessing application services on the AppServer from a Java client without the need to generate Open Client proxies using ProxyGen.

Appendix A "Accessing a SmartDataObject API Directly."

Describes the requirements to access SmartDataObjects from any Open Client that needs to access SmartDataObject extensions.

Appendix B, "Java Open Client Certificate Management Utility"

Describes managing certificate store files and converting digital certificates. If your Open Client application uses HTTPS (SSL), you must provide digital certificates with the application.

Appendix C, "Passing Temp-tables as SQL ResultSet Parameters"

Describes how to pass and manage temp-tables as SQL ResultSet objects.

Typographical conventions

This manual uses the following typographical conventions:

Convention	Description
Bold	Bold typeface indicates commands or characters the user types, provides emphasis, or the names of user interface elements.
Italic	Italic typeface indicates the title of a document, or signifies new terms.
SMALL, BOLD CAPITAL LETTERS	Small, bold capital letters indicate OpenEdge® key functions and generic keyboard keys; for example, GET and CTRL.
KEY1+KEY2	A plus sign between key names indicates a simultaneous key sequence: you press and hold down the first key while pressing the second key. For example, CTRL+X.
KEY1 KEY2	A space between key names indicates a sequential key sequence: you press and release the first key, then press another key. For example, ESCAPE H.
Syntax:
Fixed width	A fixed-width font is used in syntax statements, code examples, system output, and filenames.
Fixed-width italics	Fixed-width italics indicate variables in syntax statements.
Fixed-width bold	Fixed-width bold indicates variables with special emphasis.
UPPERCASE fixed width	Uppercase words are Progress® 4GL language keywords. Although these are always shown in uppercase, you can type them in either uppercase or lowercase in a procedure.
	This icon (three arrows) introduces a multi-step procedure.
	This icon (one arrow) introduces a single-step procedure.
Period (.) or colon (:)	All statements except DO, FOR, FUNCTION, PROCEDURE, and REPEAT end with a period. DO, FOR, FUNCTION, PROCEDURE, and REPEAT statements can end with either a period or a colon.
[ ]	Large brackets indicate the items within them are optional.
[ ]	Small brackets are part of the Progress 4GL language.
{ }	Large braces indicate the items within them are required. They are used to simplify complex syntax diagrams.
{ }	Small braces are part of the Progress 4GL language. For example, a called external procedure must use braces when referencing arguments passed by a calling procedure.
|	A vertical bar indicates a choice.
...	Ellipses indicate repetition: you can choose one or more of the preceding items.

Example procedures

This manual provides numerous example procedures that illustrate syntax and concepts. You can access the example files and details for installing the examples from the following locations:

The Documentation and Samples CD that you received with your product.
The Progress Documentation Web site:

http://www.progress.com/products/documentation

After you install the examples, you can find the Java Open Client samples in the following location:

Doc_and_Samples_Install/src/samples/open4gl/java/